From bdf35e034a749f03fd704889479b37ac9e82a1b0 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 29 Aug 2014 15:11:11 -0400 Subject: [PATCH] GtkAboutDialog: Add formatting examples to the docs We were not very explicit about the expected format for links and email addresses in the strings, so give some explicit examples. --- gtk/gtkaboutdialog.c | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c index 5729d46474..d6b25728f7 100644 --- a/gtk/gtkaboutdialog.c +++ b/gtk/gtkaboutdialog.c @@ -68,14 +68,18 @@ * a program like its logo, name, copyright, website and license. It is * also possible to give credits to the authors, documenters, translators * and artists who have worked on the program. An about dialog is typically - * opened when the user selects the `About` option from - * the `Help` menu. All parts of the dialog are optional. + * opened when the user selects the `About` option from the `Help` menu. + * All parts of the dialog are optional. * * About dialogs often contain links and email addresses. GtkAboutDialog * displays these as clickable links. By default, it calls gtk_show_uri() * when a user clicks one. The behaviour can be overridden with the * #GtkAboutDialog::activate-link signal. * + * To specify a person with an email address, use a string like + * "Edgar Allan Poe ". To specify a website with a title, + * use a string like "GTK+ team http://www.gtk.org". + * * To make constructing a GtkAboutDialog as convenient as possible, you can * use the function gtk_show_about_dialog() which constructs and shows a dialog * and keeps it around so that it can be shown again. -- 2.30.2